/*
 * Copyright 2010-2012 Susanta Tewari. <freecode4susant@users.sourceforge.net>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package bd.org.apache.commons.math.linear;

import bd.org.apache.commons.math.exception.MultiDimensionMismatchException;
import bd.org.apache.commons.math.exception.util.LocalizedFormats;

/**
 * Exception to be thrown when either the number of rows or the number of
 * columns of a matrix do not match the expected values.
 *
 * @version $Id: MatrixDimensionMismatchException.java 1244107 2012-02-14 16:17:55Z erans $
 * @since 3.0
 */
public class MatrixDimensionMismatchException extends MultiDimensionMismatchException {

    /**
     * Serializable version Id.
     */
    private static final long serialVersionUID = -8415396756375798143L;

    /**
     * Construct an exception from the mismatched dimensions.
     *
     * @param wrongRowDim Wrong row dimension.
     * @param wrongColDim Wrong column dimension.
     * @param expectedRowDim Expected row dimension.
     * @param expectedColDim Expected column dimension.
     */
    public MatrixDimensionMismatchException(int wrongRowDim, int wrongColDim, int expectedRowDim,
            int expectedColDim) {

        super(LocalizedFormats.DIMENSIONS_MISMATCH_2x2, new Integer[] { wrongRowDim, wrongColDim },
              new Integer[] { expectedRowDim,
                              expectedColDim });
    }

    /**
     * @return the expected row dimension.
     */
    public int getWrongRowDimension() {

        return getWrongDimension(0);
    }


    /**
     * @return the expected row dimension.
     */
    public int getExpectedRowDimension() {

        return getExpectedDimension(0);
    }


    /**
     * @return the wrong column dimension.
     */
    public int getWrongColumnDimension() {

        return getWrongDimension(1);
    }


    /**
     * @return the expected column dimension.
     */
    public int getExpectedColumnDimension() {

        return getExpectedDimension(1);
    }
}
